# -*- mode: Awk; -*-  vim: set filetype=awk : 
#
# This file is part of KNIT; copyright (C) 2010 by Tim Menzies
# tim@menzies.us.
#
# KNIT is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# KNIT is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with KNIT.  If not, see <http://www.gnu.org/licenses/>.

KNIT Coding Conventions

This is a rapidly changing file.

Applications
============

Applications are built in their own directory and have have

+ app.wak : the main driver
+ Makefile : the controller for building, testing, etc
+ etc/tests : a sub-directory for examples.

Tests
=====

Everything released has a test/demo call.

Source Code
===========

Source code is offered in .wak files.

Source code starts with KNIT copyright statement (see the file `head`).

Verbatim text is defined in paragraphs indented by _two_ white space characters.

Source code is defined  in paragraphs  indended by _one_ white space character.
Source code functions cannot have blank lines. If you really need white space lines
between (e.g.) pairs of related functions, add in 3 blank characters  at the front of those
lines.

AWK Souce Code Conventions
--------------------------
 
See [?awkidioms].

